reservations-eapi

Whilst every effort will be made to capture all errors which may be returned for these API resources on this page, consumers are advised that as RDG are using a common service (frequently known as Software as a Service or SaaS) for the underlying technology within the reservation service, additional error cases may be added to the product at any time. If you are returned an error not recorded here, please provide details to RDG, including the request which generated the error and the error message itself, and we will investigate and add to this page.

Platform Error Format

The Developer Portal will return an error if submitted requests do not comply with one or more of an API's policies. A common example of this is the security policy, which requires a valid JWT in every request. If the request doesn't include a valid JWT then the Portal will reject the request immediately and make no attempt to process it. Rejected requests of this nature will result in a platform error, which has the following simple format (See Platform Error Object data type):

{
"error" : "error message"
}

RDG Error format

If a request passes the policy checks it will be submitted to the relevant RDG API which may then result in an RDG specific error as opposed to a generic platform error. APIs on the RDG Developer Portal use the following common error format to contain and return these errors to consumers (See RDG Error Object data type):

{
"errors": [
{
"code": "error_code",
"message": "error message",
"timestamp": "YYYY-MM-DDTHH:MM:SS",
"context":
{
"{key}": "value"
}
}
]
}

The context object is an unspecified list of key value pairs, allowing new context information to be provided without requiring a schema change.

Reservations specific error handling

For the reservations service, the below list represents the known context keys which may be returned by the source service. This list is not within RDG control and is subject to change at any time. Please report any context keys which are not in the list below to cci-support@raildeliverygroup.com and RDG will review and update this page to include them.

Field name keys:
location disabilityType
rsid departureDate
serviceOriginDate ticketTypeCode
routeCode statusCode

There may also be context items which are not field names, such as:
expected got
reason description

Known Error Cases

General

Availability

Booking

Services (Coach)

Last update: 01-Dec-2023 09.55: ASSIST API Documentation Maintenance: 'reservations-eapi', Version 'v1', Page 'Error handling', Revision 'F'.

To request updates to this text please contact Neil Barkham.